<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    




<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


        
    
    </div>

    

    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="ERROR_LOADING_PLAYLIST"><span class="type-signature">(constant) </span>ERROR_LOADING_PLAYLIST<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Playback stopped because the playlist failed to load.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="ERROR_LOADING_PLAYLIST_ITEM"><span class="type-signature">(constant) </span>ERROR_LOADING_PLAYLIST_ITEM<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Between playlist items, the required provider could not be loaded be.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="ERROR_LOADING_PROVIDER"><span class="type-signature">(constant) </span>ERROR_LOADING_PROVIDER<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Using the load API, the required provider could not be loaded.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="FLASH_ERROR"><span class="type-signature">(constant) </span>FLASH_ERROR<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>An error occurred during Flash playback.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="FLASH_MEDIA_ERROR"><span class="type-signature">(constant) </span>FLASH_MEDIA_ERROR<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>A media error occurred during Flash playback.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="FLASH_SETUP_ERROR"><span class="type-signature">(constant) </span>FLASH_SETUP_ERROR<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>An error occurred duing Flash setup.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="HTML5_BASE_MEDIA_ERROR"><span class="type-signature">(constant) </span>HTML5_BASE_MEDIA_ERROR<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <ul>
<li>The HTML5 media element encountered an error.</li>
</ul>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="HTML5_ERROR_LIVE_STREAM_DOWN_OR_ENDED"><span class="type-signature">(constant) </span>HTML5_ERROR_LIVE_STREAM_DOWN_OR_ENDED<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <ul>
<li>The HTML5 live stream is down or has ended.</li>
</ul>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="HTML5_NETWORK_ERROR"><span class="type-signature">(constant) </span>HTML5_NETWORK_ERROR<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <ul>
<li>The HTML5 media element encountered a network error.</li>
</ul>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="load"><span class="type-signature"></span>load<span class="type-signature"></span></h4>




<div class="description">
    <p>Controller API / public methods</p>
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LICENSE_EXPIRED"><span class="type-signature">(constant) </span>SETUP_ERROR_LICENSE_EXPIRED<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because the license key expired.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LICENSE_INVALID"><span class="type-signature">(constant) </span>SETUP_ERROR_LICENSE_INVALID<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because the license key was invalid.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LICENSE_MISSING"><span class="type-signature">(constant) </span>SETUP_ERROR_LICENSE_MISSING<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because no license key was found.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LOADING_CORE_JS"><span class="type-signature">(constant) </span>SETUP_ERROR_LOADING_CORE_JS<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because a core module failed to load.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LOADING_PLAYLIST"><span class="type-signature">(constant) </span>SETUP_ERROR_LOADING_PLAYLIST<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because the playlist failed to load.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_LOADING_PROVIDER"><span class="type-signature">(constant) </span>SETUP_ERROR_LOADING_PROVIDER<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because the initial provider failed to load.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_TIMEOUT"><span class="type-signature">(constant) </span>SETUP_ERROR_TIMEOUT<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Setup failed because it took longer than 30 seconds.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
            
<h4 class="name" id="SETUP_ERROR_UNKNOWN"><span class="type-signature">(constant) </span>SETUP_ERROR_UNKNOWN<span class="type-signature"> :ErrorCode</span></h4>




<div class="description">
    <p>Base code for a setup failure.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">ErrorCode</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="jwplayer"><span class="type-signature"></span>jwplayer<span class="signature">(query<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Api.html">Api</a>|object}</span></h4>
    

    



<div class="description">
    <p>Return an instance of <a href="Api.html">the JW Player API</a> matching an element on the page or an existing player.</p>
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>query</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>
|

<span class="param-type">HTMLElement</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>This can be an element id, player index or DOM element.
When left out, this method attempts to return the first available player.</p></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    <ul>
<li>Returns a player instance if one matches the provided query.
Otherwise, returns an object containing the <code>registerPlugin</code> method.</li>
</ul>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Api.html">Api</a></span>
|

<span class="param-type">object</span>


    </dd>
</dl>

    





        
    

    
        <h3 class="subsection-title">Type Definitions</h3>

        
                
<h4 class="name" id="AudioTrackOption">AudioTrackOption</h4>




<div class="description">
    <p>Audio Track information for tracks returned by <a href="Api.html#getAudioTracks">jwplayer().getAudioTracks()</a></p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>autoselect</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaulttrack</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>groupid</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>language</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="BrowserEnvironment">BrowserEnvironment</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>androidNative</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Android Native?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>chrome</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Chrome?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>edge</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Edge?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>facebook</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser a Facebook webview?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>firefox</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Firefox?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ie</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Internet Explorer?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>msie</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser MSIE?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>safari</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the browser Safari?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#EnvironmentVersion">EnvironmentVersion</a></span>


            
            </td>

            

            

            <td class="description last"><p>The browser version.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="CaptionsTrackOption">CaptionsTrackOption</h4>




<div class="description">
    <p>Captions Track information for tracks returned by <a href="Api.html#getCaptionsList">jwplayer().getCaptionsList()</a></p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="Environment">Environment</h4>




<div class="description">
    <p>Environment information for the current session, return by <a href="Api.html#getEnvironment">jwplayer().getEnvironment()</a></p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>Browser</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#BrowserEnvironment">BrowserEnvironment</a></span>


            
            </td>

            

            

            <td class="description last"><p>Information about the current session's browser.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>OS</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#OSEnvironment">OSEnvironment</a></span>


            
            </td>

            

            

            <td class="description last"><p>Information about the current session's operating system.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>Features</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#FeatureEnvironment">FeatureEnvironment</a></span>


            
            </td>

            

            

            <td class="description last"><p>Information about the current sessions's supported features.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="EnvironmentVersion">EnvironmentVersion</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The full version string.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>major</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The major version.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minor</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The minor version.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="FeatureEnvironment">FeatureEnvironment</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>flash</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Does the browser environment support Flash?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>flashVersion</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The version of Flash.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iframe</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the session in an iframe?</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="OSEnvironment">OSEnvironment</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>android</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the operating system Android?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iOS</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the operating system iOS?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mobile</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the operating system iOS or Android?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>osx</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the operating system Mac OS X?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iPad</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the device an iPad?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iPhone</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the device an iPhone?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>windows</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Is the operating system Windows?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>version</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#EnvironmentVersion">EnvironmentVersion</a></span>


            
            </td>

            

            

            <td class="description last"><p>The operating system version.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="PlayerQoE">PlayerQoE</h4>




<div class="description">
    <p>Player QoE returned from <a href="Api.html#qoe">jwplayer().qoe()</a></p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>setupTime</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of milliseconds from <code>jwplayer().setup()</code> to the &quot;ready&quot; event.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>firstFrame</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of milliseconds from the &quot;playAttempt&quot; event to the &quot;firstFrame&quot; event.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>player</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TimerMetrics">TimerMetrics</a></span>


            
            </td>

            

            

            <td class="description last"><p>The QoE metrics of the player.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>item</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TimerMetrics">TimerMetrics</a></span>


            
            </td>

            

            

            <td class="description last"><p>The QoE metrics of the current playlist item.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="PlaylistItem">PlaylistItem</h4>




<div class="description">
    <p>An item in the playlist</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>file</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>The selected source URL to be played.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sources</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#PlaylistItemSource">PlaylistItemSource</a>></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>A list of alternative media sources for the player to choose from.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>tracks</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#PlaylistItemTrack">PlaylistItemTrack</a>></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>A list of tracks associated with this item.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>image</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>The poster image.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>preload</code></td>
            

            <td class="type">
            
                
<span class="param-type">'none'</span>
|

<span class="param-type">'metadata'</span>
|

<span class="param-type">'auto'</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>The selected preload setting.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minDvrWindow</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>For live streams, the threshold at which the available media should be seekable,
and treated as a DVR stream.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dvrSeekLimit</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>For live streams, the number of seconds away from the live edge the user is allowed to seek to</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="PlaylistItemSource">PlaylistItemSource</h4>




<div class="description">
    <p>A media source variant present in a playlist item</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>file</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The media URL.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The type (common file extension) of media.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>default</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Default sources are prioritized over others.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The quality label to be used with multiple mp4/webm sources.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="PlaylistItemTrack">PlaylistItemTrack</h4>




<div class="description">
    <p>A media source variant present in a playlist item</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>kind</code></td>
            

            <td class="type">
            
                
<span class="param-type">'captions'</span>
|

<span class="param-type">'subtitles'</span>
|

<span class="param-type">'chapters'</span>
|

<span class="param-type">'thumbnails'</span>


            
            </td>

            

            

            <td class="description last"><p>The kind of track.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>default</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Enable the track by default.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="ProviderInfo">ProviderInfo</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The name of the Provider handling playback.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="QualityOption">QualityOption</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">option</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>label</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bitrate</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="SafeRegion">SafeRegion</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The position in pixels from the left of the player, not covered by controls.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The position in pixels from the top of the player, not covered by controls.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The width of the safe region.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The height of the safe region.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="SliderCue">SliderCue</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>begin</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The time at which the cue should be placed in seconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>text</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The text label of the cue.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="TimerMetrics">TimerMetrics</h4>




<div class="description">
    <p>QoE metrics returned by <code>jwplayer()._qoe.dump()</code>.
<a href="Api.html#qoe">jwplayer().qoe():PlayerQoE</a> returns these for the player and the current playlist item.</p>
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>counts</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"><p>Lists event counts by event name</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>events</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"><p>Lists last event timestamps (epoch ms) by event name</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>sums</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"><p>Lists total event/state duration by event/state name</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
                
<h4 class="name" id="VisualQuality">VisualQuality</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>level</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#QualityOption">QualityOption</a></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>The quality option associated with the active visual quality.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mode</code></td>
            

            <td class="type">
            
                
<span class="param-type">'auto'</span>
|

<span class="param-type">'manual'</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>Whether the quality was selected automatically (adaptive quality switch) or manually.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>reason</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">'initial choice'</span>
|

<span class="param-type">'auto'</span>
|

<span class="param-type">'api'</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>The reason for the quality change.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bitrate</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>The bitrate of the the active visual quality.</p></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>






            
    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Api.html">Api</a></li><li><a href="BackgroundMedia.html">BackgroundMedia</a></li><li><a href="InstreamAdapter.html">InstreamAdapter</a></li><li><a href="PlayerError.html">PlayerError</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ERROR_LOADING_PLAYLIST">ERROR_LOADING_PLAYLIST</a></li><li><a href="global.html#ERROR_LOADING_PLAYLIST_ITEM">ERROR_LOADING_PLAYLIST_ITEM</a></li><li><a href="global.html#ERROR_LOADING_PROVIDER">ERROR_LOADING_PROVIDER</a></li><li><a href="global.html#FLASH_ERROR">FLASH_ERROR</a></li><li><a href="global.html#FLASH_MEDIA_ERROR">FLASH_MEDIA_ERROR</a></li><li><a href="global.html#FLASH_SETUP_ERROR">FLASH_SETUP_ERROR</a></li><li><a href="global.html#HTML5_BASE_MEDIA_ERROR">HTML5_BASE_MEDIA_ERROR</a></li><li><a href="global.html#HTML5_ERROR_LIVE_STREAM_DOWN_OR_ENDED">HTML5_ERROR_LIVE_STREAM_DOWN_OR_ENDED</a></li><li><a href="global.html#HTML5_NETWORK_ERROR">HTML5_NETWORK_ERROR</a></li><li><a href="global.html#jwplayer">jwplayer</a></li><li><a href="global.html#load">load</a></li><li><a href="global.html#SETUP_ERROR_LICENSE_EXPIRED">SETUP_ERROR_LICENSE_EXPIRED</a></li><li><a href="global.html#SETUP_ERROR_LICENSE_INVALID">SETUP_ERROR_LICENSE_INVALID</a></li><li><a href="global.html#SETUP_ERROR_LICENSE_MISSING">SETUP_ERROR_LICENSE_MISSING</a></li><li><a href="global.html#SETUP_ERROR_LOADING_CORE_JS">SETUP_ERROR_LOADING_CORE_JS</a></li><li><a href="global.html#SETUP_ERROR_LOADING_PLAYLIST">SETUP_ERROR_LOADING_PLAYLIST</a></li><li><a href="global.html#SETUP_ERROR_LOADING_PROVIDER">SETUP_ERROR_LOADING_PROVIDER</a></li><li><a href="global.html#SETUP_ERROR_TIMEOUT">SETUP_ERROR_TIMEOUT</a></li><li><a href="global.html#SETUP_ERROR_UNKNOWN">SETUP_ERROR_UNKNOWN</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>